docs: the README still said fifteen rules, and now a test says otherwise - #150
Merged
Conversation
0.7.0 delisted `autonomous-unapproved-write` because it could not fire on any capture surface a user installs. That release existed to make published claims true. It updated docs/detection-rules.md, the Sigma pack and the whitepaper, and missed the most read document in the repository. The number was spelled out as a word, "Fifteen built-in rules ship today", so it matched no numeric search and survived three passes over the file. It is now fourteen published plus one experimental. The Sigma count was worse: the README said four rules while the pack ships 23. That one drifted because the pack is generated, so it grows without anyone editing prose about it. Both are now pinned. test_readme_claims.py already stopped the corpus counts rotting; it now covers the rule total and the Sigma pack size, and I checked that reintroducing either stale number fails the suite rather than trusting that it would. Also links the OWASP AST10 coverage table from the detection section, since a reader following the rules link is exactly the reader who wants to know which risks this does not cover. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two stale claims in the most read file
"Fifteen built-in rules ship today." 0.7.0 delisted
autonomous-unapproved-writebecause it could not fire on any capture surface a user installs. That release existed to make published claims true, and it fixeddocs/detection-rules.md, the Sigma pack and the whitepaper. It missed the README.The number was spelled as a word, so it matched no numeric search and survived three passes over the file. Now: fourteen published plus one experimental.
"Sigma pack (4 rules)." The pack ships 23. That one drifted because the pack is generated, so it grows without anyone editing prose about it.
Pinned, and the pin is verified
test_readme_claims.pyalready stopped the corpus counts rotting. It now covers the rule total and the Sigma pack size.I checked the guards bite rather than assuming:
The rule-count test checks spelled-out words as well as digits, because that is how this one hid.
Also
Links the OWASP AST10 coverage table from the detection section. A reader following the rules link is exactly the reader who wants to know which risks this does not cover.
1,168 tests, ruff clean.
🤖 Generated with Claude Code